home *** CD-ROM | disk | FTP | other *** search
/ MacFormat España 27 / MacFormat n. 27 (Spain) / Mac Format 26.bin / Shareware / Comunicaciones / mtx2html 1.5.5 / guide / format.txt < prev    next >
Encoding:
Text File  |  1997-01-20  |  8.7 KB  |  216 lines
  1. Summary of Simple Marked Text (MTX) Format
  2. Version 1.5.5 - January 1997
  3.  
  4. General Considerations
  5.  
  6.   Source file names have an .mtx extension.
  7.   HTML file names have an .html extension.
  8.   Files contain only ASCII characters
  9.     (return, linefeed, tab, space to ~).
  10.   Paragraphs are delimited by blank lines. Extra blank
  11.     lines will be eliminated. Adjacent lines will be
  12.     combined into a single paragraph.
  13.   Lines indented with spaces or tabs will become an item
  14.     in a list.
  15.   Items marked by a "N" use Netscape HTML extensions. For
  16.     maximum compatibility, avoid these tags.
  17.   Items marked by a "**" are depreciated. They will disappear
  18.     in a future release of MTX and should be avoided.
  19.     
  20. Special Tags (must occur one to a line at top of file)
  21.  
  22.   %TITLE title       - title for HTML page
  23.  N%TITLE $title      - title with centered heading 
  24. **%HEADING none      - supress heading
  25. **%HEADING heading   - heading different from title
  26. **%HEADING $heading  - centered heading
  27.   %FILE name         - name for HTML file
  28.   %IMAGES path       - path for image files
  29. **%LOGO name         - title inline graphic (.gif)
  30. **%LOGO $name        - centered title graphic (.gif)
  31.  N%WATERMARK name    - watermark graphic (.gif)
  32.  N%COLORS colors     - background and text colors
  33.   %HOME text         - label for home document
  34.   %HOMEURL url       - URL for home document
  35.   %HOMEURL none      - no URL for home document
  36.   %PARENT text       - label for parent document
  37.   %PARENTURL url     - URL for parent document
  38.   %PARENTURL none    - no URL for parent document
  39.   %INDEX text        - label for index document
  40.   %INDEXURL url      - URL for index document
  41.   %INDEXURL none     - no URL for index document
  42.   %PREV text         - label for previous document
  43.   %PREVURL url       - URL for previous document
  44.   %PREVURL none      - no URL for previous document
  45.   %NEXT text         - label for next document
  46.   %NEXTURL url       - URL for next document
  47.   %NEXTURL none      - no URL for next document
  48.   %BASE path         - path for relative URLs
  49.   %PATH path         - path for document only
  50.   %AUTHOR text       - author info
  51.   %AUTHURL url       - URL for author
  52.   %CONTACT text      - page contact info
  53.   %CONTURL url       - URL for page contact
  54.   %VERSION text      - document version info
  55.   %VERSURL url       - URL for document version
  56.   %COPYRIGHT text    - document copyright info
  57.   %COPYURL url       - URL for document copyright
  58.   %OUTLINE none      - no outline
  59.   %OUTLINE long      - long outline
  60.   %LAYOUT cover      - suppress administrative info
  61.   %LAYOUT print      - suppress navigation info
  62. **%LAYOUT keyword    - file contains a keyword list
  63. **%LAYOUT noindex    - suppress indexing of this file
  64.   %LAYOUT feedback   - override feedback suppression
  65.   %LAYOUT nofeedback - suppress feedback for all questions
  66.   %LAYOUT url        - review materials for quizCGI tests
  67.  N%LAYOUT slide      - presentation slide format
  68.  N%REFRESH seconds   - client pull refresh
  69.  N%REFRESH secs url  - client pull refresh with link
  70.   %ABSTRACT text     - description for page indexing
  71.   %KEYWORDS words    - keywords for page indexing
  72.   %COUNTER date url  - counter date and cgi url
  73.   %QUIZCGI url       - url for quizCGI testing engine
  74.   %QUIZCGI name      - name of user list for quizCGI test
  75.   %MTX version       - MTX format version
  76.   %%text             - comment line (ignored)
  77.  
  78.   NOTE: Each document will have a short outline at the top
  79.     unless otherwise specified. Links to email addresses
  80.     will be prefixed with "mailto:" automatically. Default
  81.     "Home," "Parent," "Previous," and "Next" labels will
  82.     be used if not otherwise specified.
  83.  
  84. Heading Tags (must occur at the beginning of line)
  85.  
  86.   #heading text      - primary outline heading
  87.   ##heading text     - secondary outline heading
  88.   ###...             - up to ##### (5) levels deep
  89.   #!heading text     - page heading (if different from title)
  90.   #!!name            - page heading graphic
  91.   #!!name text       - page heading graphic with alternate text
  92.  N#$heading text     - centered heading
  93.   #text#url name     - heading link to url outside document
  94.   #text#=anchor name - use heading as named anchor
  95.  
  96.   NOTE: Any text that precedes the first #heading will appear
  97.     just after the page heading and before the outline.
  98.  
  99. Embedded Tags (can occur anywhere)
  100.  
  101.   {B}            - line break
  102.   {P}            - paragraph break
  103.   {S}            - non-breaking space
  104.   {*text*}       - strong (bold) text
  105.   {!text!}       - emphasized (italics) text
  106. **{@text@}       - fixed font text
  107.   {FtextF}       - fixed font text
  108.  N{BtextB}       - big text
  109.  N{StextS}       - small text
  110.  N{PtextP}       - superscript text
  111.  N{NtextN}       - subscript text
  112.   {=name=}       - inline graphic (.gif)
  113.   {=name text=}  - inline graphic with alternate text
  114.   {+name+}       - inline (.gif) with linked (.jpg) graphic
  115.   {+name text+}  - inline graphic with alternate text
  116.   {-name-}       - inline (.gif) with linked (.gif) graphic
  117.   {-name text-}  - inline graphic with alternate text
  118.   {#name#}       - inline (.gif) with linked (.html) file
  119.   {#name text#}  - inline graphic with alternate text
  120.  N{MnameM}       - inline (embedded .mov) quicktime movie
  121.  N{M!nameM}      - hidden (embedded .mov) quicktime audio
  122.   {#url##}         - link to quoted url
  123.   {#text#url#}     - link to url
  124.   {#text#anchor#}  - link to named anchor
  125.   {#text#=anchor#} - create named anchor
  126.  N{=\name=}      - floating graphic (left)
  127.  N{=/name=}      - floating graphic (right)
  128.  N{=$name=}      - floating graphic (vertically centered)
  129.  N{C}            - clear floating graphic alignment
  130.  
  131.   NOTE: File extensions (.gif, .jpg, .mov, and .html) are
  132.     automatically added to file names. Linked .gif files
  133.     have an "L" added to the name (pictureL.gif). Anchor
  134.     names are case sensitive (#name <> #NAME). Links to
  135.     email addresses will be prefixed with "mailto:"
  136.     automatically. Floating graphic alignment must be
  137.     cleared using {C}. Graphic alignment may also be used
  138.     with {+...+}, {-...-}, {#...#}, and {M...M}. 
  139.  
  140. List Tags (must occur after leading white space)
  141.  
  142.    text   - bulleted list item
  143.   #text   - numbered list item (1, 2, 3...)
  144.  N@text   - lettered list item (a, b, c...)
  145.  N!text   - roman numbered list item (I, II, III...)
  146.   +text   - glossary list title item (bold)
  147.   -text   - glossary list definition
  148.  
  149.   NOTE: Lists may be nested by using variable amounts
  150.     of leading white space.
  151.  
  152. Format Tags (must occur at the beginning of line)
  153.  
  154.   'text   - block quote
  155.  N''text  - pull quote
  156.   =text   - preformatted text
  157.   +text   - non print text (suppressed with print layout)
  158.  N$text   - centered text
  159.   -----   - horizontal rule (one or more dashes)
  160.  
  161. Question Tags (must occur at the beginning of line)
  162.  
  163.   ?x           - begin question (single correct answer)
  164.   ?xyz         - begin question (multiple correct answers)
  165.   ?x?none      - begin question (suppress feedback)
  166.   question text   - question text
  167.   @answer text    - answer text
  168.     feedback text - indented at least one space
  169.  
  170.   NOTE: Questions may have up to 26 (A-Z) answer choices.
  171.     Inline graphics may be used as part of any question,
  172.     answer, or feedback element.
  173.  
  174. Tables (each line must begin with "|") (N)
  175.  
  176. The first line must be one of the following:
  177.   |                     - no caption
  178.   |none                 - no caption
  179.   |caption text         - caption for table
  180.   |caption|noborder     - caption for table with no border
  181.   |caption|nowide       - caption for minimal width table
  182.   |caption|noblanks     - caption for table with no blanks
  183.   |caption|nowide|noborder|noblanks  - combination of above
  184. Subsequent lines can be variations of the following:
  185.   |text 1|text 2|text 3 - row with three cells
  186.   |text 1||text 3       - use empty cells where needed
  187.   |text 1|two   |text 3 - pad cells with spaces or tabs
  188.   |text 1\3             - use "\n" to span n columns
  189.   |text 1|*     |text 3 - non-blank empty cell use "*"
  190.   |text 1|^two  |text 3 - force cell alignment to top
  191.   |*col 1|*col 2|*col 3 - column headings begin with "*"
  192.   |*row 1|text 1|text 2 - row headings begin with "*"
  193.  
  194.   NOTE: Each line becomes one row in the table. Cells may
  195.   contain graphics or hypertext links. Use {BR} to force
  196.   word wrap within a cell. By default, tables will have
  197.   borders, blanks for empty cells, and resize to cover 95%
  198.   of the window side to side.
  199.  
  200. Author and Copyright
  201.  
  202. MTX was developed by Richard Rathe, MD, Director of the Office of Medical
  203. Informatics for the College of Medicine at the University of Florida. The MTX
  204. format, documentation, and tools are Copyright 1995 and 1996 by Richard Rathe.
  205. MTX is available without charge for non-commercial use at:
  206.  
  207.   http://www.med.ufl.edu/medinfo/mtx/
  208.  
  209. All copyright and authorship notices must remain in place.
  210.  
  211. Questions, comments, or suggestions should be sent to:
  212.  
  213.   rrathe@dean.med.ufl.edu
  214.  
  215. Enjoy! RR
  216.